<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" />
<title>index.rst</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

.subscript {
  vertical-align: sub;
  font-size: smaller }

.superscript {
  vertical-align: super;
  font-size: smaller }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

table.align-center {
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

.align-top    {
  vertical-align: top }

.align-middle {
  vertical-align: middle }

.align-bottom {
  vertical-align: bottom }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<div align="center"><p><a class="reference external" href="https://xapian.org/">website</a> | <a class="reference external" href="install.html">install</a> |
<a class="reference external" href="overview.html">overview</a> |
<a class="reference external" href="admin_notes.html">sysadmins</a> | <a class="reference external" href="scalability.html">scalability</a> |
<a class="reference external" href="apidoc/html/annotated.html">API</a> | <a class="reference external" href="deprecation.html">deprecated</a>
| <a class="reference external" href="intro_ir.html">IR</a> | <a class="reference external" href="https://trac.xapian.org/wiki">wiki</a></p>
</div>
<hr><div class="section" id="xapian-the-open-source-search-engine">
<h1>Xapian - the open source search engine</h1>
<div class="section" id="getting-started">
<h2>Getting Started</h2>
<p>There's a new
<a class="reference external" href="https://getting-started-with-xapian.readthedocs.io/">Getting Started with Xapian</a>
guide, which is the recommended place to start.</p>
</div>
<div class="section" id="documentation">
<h2>Documentation</h2>
<p>The Omega search application has its <a class="reference external" href="https://xapian.org/docs/omega/">own documentation</a>, and there's also separate
documentation for the <a class="reference external" href="https://xapian.org/docs/bindings/">other language bindings</a>.</p>
<p>We suggest you start by reading the <a class="reference external" href="install.html">Installation
Guide</a>, which covers downloading the code, and
unpacking, configuring, building and installing it.</p>
<p>The <a class="reference external" href="glossary.html">glossary</a> provides definitions for specialized
terminology you might encounter while using Xapian.</p>
<p>The <a class="reference external" href="overview.html">Overview</a> explains the API which Xapian provides
to programmers.  A full <a class="reference external" href="apidoc/html/index.html">API Reference</a> is
automatically collated using doxygen from documentation comments in
the source code.  There's also a list of <a class="reference external" href="deprecation.html">deprecated features</a> which lists features scheduled for removal, and
also features already removed, along with suggestions for
replacements.</p>
<p>If you want to learn more about information retrieval, there's a (reasonably
mathematical) <a class="reference external" href="intro_ir.html">introduction to the ideas behind Xapian</a> which
also suggests some books you might want to read.</p>
<p>There are a number of documents which cover particular features:</p>
<ul class="simple">
<li><a class="reference external" href="bm25.html">BM25 Weighting Scheme</a></li>
<li><a class="reference external" href="collapsing.html">Collapsing</a></li>
<li><a class="reference external" href="replication.html">Database Replication</a></li>
<li><a class="reference external" href="facets.html">Faceting</a></li>
<li><a class="reference external" href="termgenerator.html">Indexing</a></li>
<li><a class="reference external" href="postingsource.html">PostingSource</a></li>
<li><a class="reference external" href="queryparser.html">Query Parser</a></li>
<li><a class="reference external" href="remote.html">Remote Backend</a></li>
<li><a class="reference external" href="serialisation.html">Serialising Queries and Documents</a></li>
<li><a class="reference external" href="sorting.html">Sorting Results</a></li>
<li><a class="reference external" href="spelling.html">Spelling Correction</a></li>
<li><a class="reference external" href="stemming.html">Stemming Algorithms</a></li>
<li><a class="reference external" href="synonyms.html">Synonym Support</a></li>
<li><a class="reference external" href="valueranges.html">Value Ranges</a></li>
</ul>
<p>For those wishing to do development work on the Xapian library itself,
there is <a class="reference external" href="internals.html">documentation of Xapian's internals</a>
available.</p>
<p>We also have a <a class="reference external" href="https://trac.xapian.org/wiki">wiki</a> for documentation
and examples contributed by the Xapian community.</p>
</div>
</div>
</div>
</body>
</html>
